Get Mineral Compositions

Method: GET
/api/v1/mineral-compositions

---

Description

This endpoint retrieves a list of mineral compositions. You can filter the results by mineral composition status, byproduct type, and sort order.

---

🔑 Authentication

This endpoint requires authentication via headers.

Param	Value	Type
tenantId	{{tenantId}}	string
userId	{{userId}}	string
countryCode	{{countryCode}}	string

---

Query Parameters

Name	Type	Description
activeMineralComposition	string	Filter by active mineral composition (Available values: 0, 1).
mineralCompositionByproductTypeIds	string	Filter by byproduct type IDs.
order	string	Sort results in ascending (ASC) or descending (DESC) order.
page	string	Specify the page number for paginated results.
limit	string	Specify the number of results per page.

---

Response: 200 OK

A successful response returns a list of mineral compositions with their details.

Example Response:

[
  {
    "compositionId": "12345",
    "name": "Iron Ore",
    "description": "High-grade iron ore",
    "active": 1,
    "byproductType": "Mineral",
    "createdAt": "2025-02-12T04:04:39.986Z"
  },
  {
    "compositionId": "67890",
    "name": "Copper",
    "description": "Pure copper",
    "active": 1,
    "byproductType": "Metal",
    "createdAt": "2025-02-10T11:22:30.000Z"
  }
]